Import Customer

Import Customer lets you import a customer from Live Platform Operation Center.

URI

Copy 
{{baseUrl}}/api/v2/customer/customerGuid/action/ovocimport

HTTP Method

POST

Example Request Body

Copy 
{
"customerType": "IPGROUP_TYPE",
"customerSource": "LTC",
"customerMsTenantId": "4bf50a33-a383-4d3f-9403-220c898bc1b2",
"lcCustomerId": "1317092"
}

Request Body

Parameter

Type

Description

customerType

string

One of the following values:

■ TENANT_TYPE
■ IPGROUP_TYPE
■ TENANT_TYPE_GW

customerSource (optional)

string

One of the following values:

■ LTC-Live Platform
■ OC-Operator Connect

customerMsTenantId (optional)

string

Microsoft Tenant Subscription Id

lcCustomerId (optional)

string

The Id of the Customer entity in the Operation Center portal. When you specify this value, the new service is created under this entity in the Live Platform topology tree.

This value is currently not retrievable using the REST API. If not specified, both a new customer and service entity are created as separate entities in the Operation Center portal with the same shortName as shown in the example figures below.

Workaround: As a temporary workaround for retrieving this value:

1. Select the relevant customer entity in the Operation Center portal.
2. Open the F12 Debugging mode, select the tabs as shown in the figure below.
3. Copy the 'id' value for the relevant customer.

If you cannot find the relevant value for your customer verify that the number of entries displayed includes your customer. If not, change the page filters to display more entries.

allowSbcIdUpdateForOvoc (optional)

boolean

default: false
■ True: The SBC device that is associated with the SIP Connection for the service is not configured in Live Platform Operation Center, the SBC id is configured on the Live Platform Operation Center. As a result, a new corresponding value "Ovoc Sbc Id" is created.
■ False: The SBC device that is associated with the SIP Connection for the service is already configured on Live Platform Operation Center.

Example Response

The initial response displays the Task Id.

Parameter

Type

Description

taskId

string

The queued task Id that is generated for this action. You must run the Task request to retrieve the status of the action. See Task Status. Note that the tsk_ string in the prefix is unique for this endpoint.
Copy 
"tsk_185510"

The execution of the request may take a few minutes. The status will progress from 'In Progress' to 'Completed Success'. See for details.

Copy 
{
    "id": "tsk_185510",
    "status": "CompletedSuccess",
    "details": [
        null
    ],
    "executionMessages": [],
    "outputData": {},
    "createTime": "0001-01-01T00:00:00",
    "completeTime": null,
    "cancellationRequested": null
}        

HTTP Responses

■ 200 OK

Parameter

Type

Description

id

string

The task Id that is generated for this action. See Task Status.

status

string

Aggregated status reflecting update status on both the Live Platform and Operator Connect:

■ Completed Success
■ Failed

details

array

Additional details.

executionMessages

null

 Internal debugging messages.

outputData

list array

-

createTime

string($date-time)

Timestamp indicating the time that the license upgrade request was initiated.

completeTime

string($date-time)

Timestamp indicating the time that the license upgrade request processing completed.

cancellationRequested

Boolean

Indicates whether the request processing was canceled by the client application. This parameter is not relevant for Live Platform.